<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="IE=edge,chrome=1" charset="utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>BE</title>
        <link rel="stylesheet" href="../css/default.css" type="text/css" media="screen, projection">
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Array.html">Array</a></li>
	
	<li><a href="../symbols/BE.html">BE</a></li>
	
	<li><a href="../symbols/BE.comp.html">BE.comp</a></li>
	
	<li><a href="../symbols/BE.ERROR.html">BE.ERROR</a></li>
	
	<li><a href="../symbols/BE.layer.html">BE.layer</a></li>
	
	<li><a href="../symbols/BE.log.html">BE.log</a></li>
	
	<li><a href="../symbols/BE.proj.html">BE.proj</a></li>
	
	<li><a href="../symbols/BE.time.html">BE.time</a></li>
	
	<li><a href="../symbols/BE.ui.html">BE.ui</a></li>
	
	<li><a href="../symbols/BE.ui.viewsConstructor.html">BE.ui.viewsConstructor</a></li>
	
	<li><a href="../symbols/BE.util.SettingsManager.html">BE.util.SettingsManager</a></li>
	
	<li><a href="../symbols/String.html">String</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace BE
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				<br />Version
					0.1.0 dev.<br />
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_Users_collinbrooks_Dropbox_Scripts_AEScripts_BeforeEffects_src_beforeeffects.jsx.html">beforeeffects.jsx</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class BE.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/BE.html#constructor">BE</a></b>
							</div>
							<div class="description">The <code>BE</code> Object aims to be an all-purpose collection of useful
methods that increases efficiency in creating scripts for After Effects.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class BE.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								BE.<b><a href="../symbols/BE.html#.BASE_PATH">BASE_PATH</a></b>
								</div>
								<div class="description">The base folder of the beforeeffects.jsx file relative to this file with
no trailing slash.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/BE.html#-that">that</a></b>
								</div>
								<div class="description">A reference to this function's <code>this</code> value for use within
methods/functions defined by the <code>BE</code> Object.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class BE.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.alertError">alertError</a></b>(e)
								</div>
								<div class="description">Alerts an Error Object, OR a String error, to the user.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.getVersion">getVersion</a></b>()
								</div>
								<div class="description">Returns the version string of the current <code>BE</code> Object.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.isBoolean">isBoolean</a></b>(val)
								</div>
								<div class="description">Returns true if the specified value is a boolean</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.isDef">isDef</a></b>(val)
								</div>
								<div class="description">Returns true if the specified value is not |undefined|.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.isDefAndNotNull">isDefAndNotNull</a></b>(val)
								</div>
								<div class="description">Returns true if the specified value is defined and not null.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.isFunc">isFunc</a></b>(val)
								</div>
								<div class="description">Returns true if the specified value is a function.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.isNull">isNull</a></b>(val)
								</div>
								<div class="description">Returns true if the specified value is truly |null|.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.isNumber">isNumber</a></b>(val)
								</div>
								<div class="description">Returns true if the specified value is a number</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.isString">isString</a></b>(val)
								</div>
								<div class="description">Returns true if the specified value is a string</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.mixin">mixin</a></b>(target, source)
								</div>
								<div class="description">Copies all the members of a source object to a target object.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.nameToPath">nameToPath</a></b>(name)
								</div>
								<div class="description">Takes a name in object notation and returns the file path to the script
that defines the object relative to the <a href="../symbols/BE.html#.BASE_PATH">BE.BASE_PATH</a> without the
/ prefix.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.provide">provide</a></b>(name)
								</div>
								<div class="description">Provides an object structure without overwriting already defined
namespaces, methods or properties.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.require">require</a></b>(name)
								</div>
								<div class="description">Imports the module defined by the given name path if it has not already
been defined; If the module cannot be found, an exception is raised.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.runScript">runScript</a></b>(path)
								</div>
								<div class="description">Evaluates the script that resides at the given file path relative to the
<a href="../symbols/BE.html#.BASE_PATH">BE.BASE_PATH</a>.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.<b><a href="../symbols/BE.html#.setDebugLevel">setDebugLevel</a></b>(l)
								</div>
								<div class="description">Set the debug level for the <code>BE.log</code> method.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>BE</b>
				</div>
				
				<div class="description">
					The <code>BE</code> Object aims to be an all-purpose collection of useful
methods that increases efficiency in creating scripts for After Effects.
					
				</div>
				
				
				
				
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">Returns:</dt>
						
								<dd><span class="light fixedFont">{Object}</span> The <code>BE</code> Object</dd>
						
						</dl>
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name=".BASE_PATH"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.</span><b>BASE_PATH</b>
					
					</div>
					<div class="description">
						The base folder of the beforeeffects.jsx file relative to this file with
no trailing slash.
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-that"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;inner&gt; 
					
					
					<b>that</b>
					
					</div>
					<div class="description">
						A reference to this function's <code>this</code> value for use within
methods/functions defined by the <code>BE</code> Object.
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".alertError"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.</span><b>alertError</b>(e)
					
					</div>
					<div class="description">
						Alerts an Error Object, OR a String error, to the user. If the error
message is greater than a preset amount, the error is displayed in a
scrollable window.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>|Error}</span> <b>e</b>
									
								</dt>
								<dd>If the argument is a String, this variable will
be used to alert the string to the user. If it is an Error, the fields
within the Error will be used to alert the user.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Nothing.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getVersion"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/String.html">String</a>}</span>
					<span class="light">BE.</span><b>getVersion</b>()
					
					</div>
					<div class="description">
						Returns the version string of the current <code>BE</code> Object.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> The <code>BE</code> Object's version string.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".isBoolean"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">BE.</span><b>isBoolean</b>(val)
					
					</div>
					<div class="description">
						Returns true if the specified value is a boolean
						
						
					</div>
					
					
					
					<pre class="code">var x = false;
BE.isBoolean(x); //true</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>val</b>
									
								</dt>
								<dd>Variable to test.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> Whether variable is boolean.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".isDef"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">BE.</span><b>isDef</b>(val)
					
					</div>
					<div class="description">
						Returns true if the specified value is not |undefined|.
<p>
WARNING: Do not use this to test if an object has a property. Use the
<code>in</code> operator instead.  Additionally, this function assumes
that the global <code>undefined</code> variable has not been redefined.
</p>
						
						
					</div>
					
					
					
					<pre class="code">var x;
BE.isDef(x); //false
x = 1;
BE.isDef(x); //true

//To check if a object has a property use this instead:
var x.blah = 1;
"blah" in x; //true
"bam" in x; //false</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>val</b>
									
								</dt>
								<dd>Variable to test.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> Whether variable is defined.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".isDefAndNotNull"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">BE.</span><b>isDefAndNotNull</b>(val)
					
					</div>
					<div class="description">
						Returns true if the specified value is defined and not null.

<p>
NOTE: <code>undefined == null</code> is <code>true</code> but
<code>undefined === null</code> is <code>false</code>.
</p>
						
						
					</div>
					
					
					
					<pre class="code">var x = null;
BE.isDefAndNotNull(x); //false
x = "I like cake";
BE.isDefAndNotNull(x); //true</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>val</b>
									
								</dt>
								<dd>Variable to test.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> Whether variable is defined and not null.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".isFunc"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">BE.</span><b>isFunc</b>(val)
					
					</div>
					<div class="description">
						Returns true if the specified value is a function.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>val</b>
									
								</dt>
								<dd>Variable to test.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> Whether variable is a function.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".isNull"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">BE.</span><b>isNull</b>(val)
					
					</div>
					<div class="description">
						Returns true if the specified value is truly |null|.
<p>
NOTE: There are a couple
of things to look out for when working with null values:
<ul>
<li><code>typeof null</code> returns '<code>object</code>' instead of
'<code>null</code>'.</li>
<li><code>null == undefined</coe> returns <code>true</code></li>
</ul>
</p>
						
						
					</div>
					
					
					
					<pre class="code">var x;
BE.isNull(x); //true
!BE.isNull(x); //false</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>val</b>
									
								</dt>
								<dd>Variable to test.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> Whether variable is null.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".isNumber"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">BE.</span><b>isNumber</b>(val)
					
					</div>
					<div class="description">
						Returns true if the specified value is a number
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>val</b>
									
								</dt>
								<dd>Variable to test.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> Whether variable is a number.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".isString"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">BE.</span><b>isString</b>(val)
					
					</div>
					<div class="description">
						Returns true if the specified value is a string
						
						
					</div>
					
					
					
					<pre class="code">var x = "howdy";
BE.isString(x); //true</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{*}</span> <b>val</b>
									
								</dt>
								<dd>Variable to test.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> Whether variable is a string.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".mixin"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.</span><b>mixin</b>(target, source)
					
					</div>
					<div class="description">
						Copies all the members of a source object to a target object. WARNING:
This includes items that aren't 'own' items!
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>target</b>
									
								</dt>
								<dd>Target.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>source</b>
									
								</dt>
								<dd>Source.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".nameToPath"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/String.html">String</a>}</span>
					<span class="light">BE.</span><b>nameToPath</b>(name)
					
					</div>
					<div class="description">
						Takes a name in object notation and returns the file path to the script
that defines the object relative to the <a href="../symbols/BE.html#.BASE_PATH">BE.BASE_PATH</a> without the
/ prefix.
						
						
					</div>
					
					
					
					<pre class="code">BE.nameToPath('BE.comp'); //returns comp/comp.jsxinc</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>name</b>
									
								</dt>
								<dd>The name of the object to return the file path for.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> The relative file path where the object with the given
name is defined.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".provide"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Object}</span>
					<span class="light">BE.</span><b>provide</b>(name)
					
					</div>
					<div class="description">
						Provides an object structure without overwriting already defined
namespaces, methods or properties.
						
						
					</div>
					
					
					
					<pre class="code"><code>BE.provide("BE.my.long.object.path");</code>
same as:
<code>BE = { my: { long: { object: { path: {}}}}};</code></pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>name</b>
									
								</dt>
								<dd>The name of the object to define.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> The last object in the path.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".require"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.</span><b>require</b>(name)
					
					</div>
					<div class="description">
						Imports the module defined by the given name path if it has not already
been defined; If the module cannot be found, an exception is raised.
						
						
					</div>
					
					
					
					<pre class="code">BE.require("BE.proj"); //runs proj/proj.jsxinc</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>name</b>
									
								</dt>
								<dd>The path to the module using object path notation
to drill down to the desired module's script. Uses the
<a href="../symbols/BE.html#.BASE_PATH">BE.BASE_PATH</a> as the root for the search.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".runScript"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">BE.</span><b>runScript</b>(path)
					
					</div>
					<div class="description">
						Evaluates the script that resides at the given file path relative to the
<a href="../symbols/BE.html#.BASE_PATH">BE.BASE_PATH</a>.
<p>
NOTE: This method does not check to see if the file has already been
evaluated.
						
						
					</div>
					
					
					
					<pre class="code">BE.runScript("comp/comp.jsxinc"); //runs BE.BASE_PATH/comp/comp.jsx
}</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>path</b>
									
								</dt>
								<dd>The file path for the script to be run.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> True if the file was succesfully evaluated, false if
it wasn't.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".setDebugLevel"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.</span><b>setDebugLevel</b>(l)
					
					</div>
					<div class="description">
						Set the debug level for the <code>BE.log</code> method.

The following levels are available:
<ul>
 <li>0 - Debug completely off.</li>
 <li>1 - Information displayed.</li>
 <li>2 - Warnings shown.</li>
</ul>
						
						
					</div>
					
					
					
					<pre class="code">BE.setDebugLevel(1);</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>l</b>
									
								</dt>
								<dd>The level number to set as the debug level.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Nothing.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/BE.log.html">BE.log</a></dd>
							
							</dl>
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			&copy;2010<br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sun May 22 2011 22:54:52 GMT-0500 (CDT)
		</div>
	</body>
</html>
